-
Notifications
You must be signed in to change notification settings - Fork 602
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
v2: Add go.mod #487
v2: Add go.mod #487
Conversation
The canonical import path of blackfriday v2 is Edit: That said, it also says:
/cc @rtfb |
I'm fairly new to Go Modules (I guess we all are), so I'm not sure what is considered best practice here. I notice https://github.com/go-yaml/yaml/blob/v2/go.mod But I'm not sure what added benefit that abstraction gives, esp. considering the network issues with GitHub vs gopkg.in last week. |
The way I read The only advantage I see to keep using the |
It seems that we need to ensure that the installation instructions work for GOPATH workspaces and in module-aware mode, but they don't necessarily have to be the same. For instance, for GOPATH, it can continue to be:
For module-aware mode, we can do:
As long as we don't run into conflicting issues that prevent both those workflows from being supported in the same repository, that could be a reasonable way to move forward. Whatever we decide and go with, it needs to be documented so people don't have to guess what import path to use. |
I think it would also help to consider what the end user wants:
|
Well, looks like we're in agreement to go ahead with this PR. The only remaining question is whether we want to update the README language somewhat, or are we okay with that as well? (I just noticed that the links to dep and Glide are broken on v2 README, so that needs updating anyway...) |
I can update the READMEs once I get to test how this works. But to test how this works I need this one merged. I suggest that you merge this and create a new minor version for both master and v2. |
SGTM, in it goes. Do you need the minor versions just for the tests, or can they be done after? |
I suggest you just tag master + v2 now. |
OK, I'll try to do that ASAP, but not today. I want to look back and collect some sort of release notes for those tags. I'll ping you back. |
Note that I have no practical experience with Go Modules and major versions, but this should be correct according to https://github.com/golang/go/wiki/Modules
I will follow up with a PR for the master branch.
I would also appreciate if this could be followed by a version tag. I plan to finally get to the Blackfriday v2 upgrade in Hugo in the near future ...